

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Add-In Search [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Add-In,Add-In Search,Search,Search Add-In,Model Search,Model Search Access From Add-In,CLASSTYPE,CLASSTYPE Add-In Hidden Field,CLASSGUID,CLASSGUID Add-In Hidden Field">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Add-In Search</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="addinmanager.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="xml_format_search_data.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">Enterprise Architect enables Add-Ins to integrate with the </span><span class="f_UIControl"><a href="search_view.htm">Model Search</a></span><span class="f_BodyText">. Searches can be defined that execute a method within your Add-In and display your results in an integrated way.</span></p>
<p class="p_BodyText"><span class="f_BodyText">The method that runs the search must be structured in the following way:</span></p>
<p class="p_OMGText"><span class="f_OMGText">variant &lt;method name&gt; (Rep as Repository, SearchText as String, XMLResults as String)</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="94" bgcolor="#e3e6ed" style="width:94px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Parameter</span></p>
</td>
<td valign="top" width="499" bgcolor="#e3e6ed" style="width:499px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Description</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="94" style="width:94px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Rep</span></p>
</td>
<td valign="top" width="499" style="width:499px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">The currently open repository.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="94" style="width:94px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">SearchText</span></p>
</td>
<td valign="top" width="499" style="width:499px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">An optional field that you can fill in through the </span><span class="f_UIControl">Model Search</span><span class="f_Tabletext">.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="94" style="width:94px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">XMLResults</span></p>
</td>
<td valign="top" width="499" style="width:499px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">At completion of the method, this should contain the results for the search. The results should be an XML String that conforms to the <a href="xml_format_search_data.htm">Search Data Format</a>.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Return</span></p>
<p class="p_BodyText"><span class="f_BodyText">The method must return a value for the results to be displayed.</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Advanced Usage</span></p>
<p class="p_BodyText"><span class="f_BodyText">In addition to the displayed results, two additional hidden fields can be passed into the XML that provide special functionality.</span></p>
<p class="p_SubHeadingL2"><span class="f_SubHeadingL2">CLASSTYPE</span></p>
<p class="p_BodyText"><span class="f_BodyText">Returning a field of CLASSTYPE, containing the Object_Type value from the t_object table, displays the appropriate icon in the column you place the field.</span></p>
<p class="p_SubHeadingL2"><span class="f_SubHeadingL2">CLASSGUID</span></p>
<p class="p_BodyText"><span class="f_BodyText">Returning a field of CLASSGUID, containing an ea_guid value, enables the </span><span class="f_UIControl">Model Search</span><span class="f_BodyText"> to track the object in the </span><span class="f_UIControl">Project Browser</span><span class="f_BodyText"> and open the </span><span class="f_UIControl">Properties</span><span class="f_BodyText"> window for the element by double-clicking in the </span><span class="f_UIControl">Model Search</span><span class="f_BodyText">.</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
